Qodex.ai

OAS API

Number of APIs: 7

Getting started guide

To start using the OAS API, you need to -

  • You must be authorized to send requests to API endpoints. You can get your API credentials from our integrations team.
  • The API has rate and usage limits.
  • The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.

Authentication

The OAS API uses bearer token for authentication.

OAS uses API credentials for authentication. You can get your API credentials from our integrations team.
You must include an API key in each request to the OAS API with the bearer request header.

Authentication error response

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

Rate and usage limits

API access rate limits apply at a per-API key basis in unit time. The limit is 300 requests per minute. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.

503 response

An HTTP 503 response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, contact support.

  1. Global-v1-Signin - Sign in method POST {{baseUrl}}/Global/v1/signin

  2. Global-v1-Customer-Settings - Create customer settings data POST {{baseUrl}}/Global/v1/customer/settings

  3. Global-v1-Customer-Settings - Update customer settings data PUT {{baseUrl}}/Global/v1/customer/settings

  4. NFSe-v1-Invoice - Send a new NFSe invoice to the selected city POST {{baseUrl}}/NFSe/v1/invoice

  5. NFSe-v1-Invoice - Get a NFSe invoice from receipt number, series, type and issue date GET {{baseUrl}}/NFSe/v1/invoice/:receiptnumber/:receiptserie/:receipttype/:issuedate

  6. NFSe-v1-Invoice - Get a NFSe invoice from a supplied integration key GET {{baseUrl}}/NFSe/v1/invoice/:integrationKey

  7. NFSe-v1-Invoice - Cancels a NFSe invoice from integration key id DELETE {{baseUrl}}/NFSe/v1/invoice/:integrationKey