Sign in

v1

latestOpenAPI 3.0.12026-07-264182324.3 KB
Agent SSO Token Authentication

After your PayNearMe Technical Account Manager has configured your site to allow for Agent SSO Token Authentication, you can begin submitting calls to the /agent_sso endpoint. The call returns an authenticating token and the SSO URL where the agent can access the Business Portal and/or the specific order.

post/agent_sso

Request body

site_identifierstring required

Identifies your client site.

timestampstring required

The Unix Epoch time of the call

versionstring required

The version of the API. This version must match the version associated with your API key pair.

signaturestring required

The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm.

agent_emailstring required

The email address of the agent.

agent_namestring required

The name of the agent.

agent_rolestring required

The name of the role set for this agent.

order_identifierstring

One of the following order identifiers, which can be used to locate the order after the agent authenticates into the Business Portal<ul><li>pnm_order_identifier</li><li>site_order_identifier</li><li>site_customer_identifier</li></ul>

Response

API Keys Revoked

statusstring

Indicates whether or not the SSO authenticating token was successfully created.

tokenstring

The authenticating SSO token.

token_expiresstring

The date and timestamp when this token expires.

sso_urlstring

The SSO URL where the agent can access the Business Portal.

Example response

{
  "status": "ok",
  "token": "Sklb-GelNo-mVwaEgZxkXI-uWc0oFRgOZxScNVEEePA",
  "token_expires": "2023-03-21 11:26:46 -0700",
  "sso_url": "https://pro.paynearme-sandbox.com/single_sign_on/Sklb-GelNo-mVwaEgZxkXI-uWc0oFRgOZxScNVEEePA"
}