Skip to main content

Making Your First API Call

Arcadier Support
Updated

Once you have a valid access token, the recommended first call is to the Marketplace Info endpoint. This confirms your credentials are valid, your environment is accessible, and your token has been correctly issued.

Retrieve your Marketplace Information

Request

GET /api/user/marketplace 
Authorization: Bearer {{ACCESS_TOKEN}}

Expected Response
A 200 response returns a JSON object containing your marketplace configuration: name, currency, domain, feature flags. A 401 response indicates an invalid or expired token.

Testing with Postman

  1. Import the collection using the Postman link provided during onboarding.
  2. Set environment variables: 
    • MARKETPLACE_ID, CLIENT_ID, CLIENT_SECRET, ACCESS_TOKEN.
  3. Run the authentication request first to populate ACCESS_TOKEN.
  4. Execute the Marketplace Info request to validate your setup.

See full API reference here.

Common Errors

  • Responses that correspond to 2xx are successful (e.g. 200 - OK)
  • Responses that correspond to 4xx are unsuccessful ones, a mistake in the input or authentication occurred. (e.g. 404 - FORBIDDEN)
  • Responses that correspond to 5xx are unsuccessful ones, due to a problem with Arcadier servers. (e.g. 500 - INTERNAL SERVER ERROR)
Status Code Meaning Recommended Action
200 OK — The request has succeeded. The client can read the result in the body and headers of the response. No action required.
201 Created — The request has been fulfilled and resulted in a new resource being created. No action required.
202 Accepted — The request has been accepted for processing, but processing has not been completed. Poll for completion or await webhook if applicable.
204 No Content — The request has succeeded but returns no message body. Handle empty response gracefully in your code.
304 Not Modified — The resource has not been modified since the last request. Use the cached version of the resource.
400 Bad Request — The request could not be understood by the server due to malformed syntax. The message body will contain more information. Review request payload against the API schema. Check required fields, data types, and formatting.
401 Unauthorized — Invalid or expired token. The request requires user authentication, or the credentials provided were refused. Re-authenticate. Check Client ID/Secret and confirm you are using the correct environment's credentials.
403 Forbidden — Insufficient role permission. The server understood the request but is refusing to fulfil it. Verify token role context matches the endpoint. Use Admin token for admin-only operations.
404 Not Found — The requested resource could not be found. This can be due to a temporary or permanent condition. Check MARKETPLACE_ID and resource GUID. Verify the resource exists in the target environment.
429 Too Many Requests — Rate limit triggered. Implement exponential backoff and retry logic.
500 Internal Server Error — Platform-side error. Contact support immediately if encountered. Retry. If it persists, contact Arcadier support with the full request/response log.
502 Bad Gateway — The server received an invalid response from the upstream server. Retry after a short delay. If it persists, contact Arcadier support.
503 Service Unavailable — The server is temporarily unable to handle the request due to a temporary condition. Resend the request after a delay. Implement retry logic with backoff.

Related to

Related articles