APIs

Qvalia API server, base rules

1

Production base URL:

https://api.qvalia.com

2

Staging / Sandbox server base URL:

https://api-qa.qvalia.com

---

All Qvalia endpoints follows the same HTTP code pattern, full set as follows:

• Error Codes

  • 200 - OK

    Everything worked as expected

  • 204 - No content

    Everything worked as expected, but we didn't find any data to return

  • 400 - Invalid request

    Invalid parameters from client

  • 401 - Unauthorized

    Unauthorized. Check your API key

  • 403 - Forbidden

    The API key doesn't have permissions to perform the request.

  • 404 - Not Found

    The requested resource does not exist. This can be either the URI, or query parameters.

  • 409 - Conflict

    The request cause some conflict, normally a duplicate

  • 422 - Unprocessable Entity

    The posted data is invalid, in the wrong format or missing

  • 429 - Too many requests You're too fast, we will block you for a while and you'll need to cool down

  • 500 - Internal error

    Internal Server Error (It's not you, it's us)

---

The /transaction (Peppol messages) all support both XML and JSON, both as request and response data!

To POST (create) any message in XML format you'll provide a header as:

POST
content-type: application/xml

Or for POST'ing JSON, you'd either omit the header, as JSON is the default, or provide:

POST
content-type: application/json

For GET'ing data you'll use the accept header instead:

GET (XML)
accept: application/xml

GET (JSON)
accept: application/json