API Reference


The Updivision API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

You can use the Updivision API in test mode, which does not affect your live data or interact with the banking networks. The API key you use to authenticate the request determines whether the request is live mode or test mode.

Authentication

The Updivision API use a token assigned to each user of application.

To authenticate API requests from your JavaScript application, you may make requests like this:

axios.get('/api/products')
    .then(response => {
        console.log(response.data);
    });

Errors

Updivision uses conventional HTTP response codes to indicate the success or failure of an API request. In general:
Codes in the 2xx range indicate success.
Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.).
Codes in the 5xx range indicate an error with Updivision's servers (these are rare).

HTTP STATUS CODE SUMMARY

200 - OK Everything worked as expected.
400 - Bad Request The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized No valid API key provided.
402 - Request Failed The parameters were valid but the request failed.
403 - Forbidden The API key doesn't have permissions to perform the request.
404 - Not Found The requested resource doesn't exist.
409 - Conflict The request conflicts with another request (perhaps due to using the same idempotent key).
429 - Too Many Requests Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
422 - Unprocessable entity The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions.
500, 502, 503, 504 - Server Errors Something went wrong on Updivision's end. (These are rare.)