Sign in

Create Access

POST https://{organization}.myguper.com/api/connect/access

Registers a new API access entry for the organization — an (apiKey, apiSecret) pair that integrations later exchange for a session token at Get token.

The apiSecret is hashed before persistence, so the plaintext is only ever seen on this request — store it on your side immediately.

Try-it values populated from environment ACME (Demo)


Authentication

Token

Most Connect endpoints require a valid x-guper-authorization token. Token issuance itself (/api/connect/auth) is the exception — it uses the x-guper-apikey and x-guper-apisecret credentials.

Headers

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Request body

Content-Type: application/json

{
    "identification": "Admin",
    "apiKey": "acme",
    "apiSecret": "a10b20c30"
}

Responses

{
    "account":        "acme",
    "identification": "Admin",
    "apiKey":         "acme",
    "apiSecret":      "**************",
    "dateTime":       "2026-05-04T13:38:24-03:00"
}

Related

Copied to clipboard