Testing and Error Handling

More often that not, testing your program’s behavior error handling behavior is a tricky thing to do. To this end, we provide a few endpoints to make your lives a bit easier.

1. Account Verification

URL endpoint: https://stamps.co.id/api/ping
Allowed method: POST

A. Request

You can query for a merchant’s data on Stamps .

Example of API call request using cURL:

$ curl -X POST -H "Content-Type: application/json" -H "Authorization: <token_type> <token>" -H "Expect:" https://stamps.co.id/api/ping -i

B. Response

If the right token is supplied, you’ll receive a response similar to this:

HTTP/1.0 200 OK
Allow: POST, OPTIONS
Content-Type: application/json
Date: Thu, 21 Aug 2014 01:44:18 GMT
Server: WSGIServer/0.1 Python/2.7.6

{
    "pong": {
        "merchant": "My Merchant",
        "merchant_id": 1
    }
}

2. Error 500

URL endpoint: https://stamps.co.id/api/500
Allowed method: GET & POST

This endpoint always returns a 500 error. For example:

$ curl "https://stamps.co.id/api/500"

Example response:

HTTP/1.0 500 INTERNAL SERVER ERROR
Content-Type: text/html; charset=utf-8
Date: Thu, 21 Aug 2014 01:48:49 GMT
Server: WSGIServer/0.1 Python/2.7.6

Server error - 500

3. Error 400

URL endpoint: https://stamps.co.id/api/400
Allowed method: GET & POST

This endpoint always returns a response with 400 error (Bad request). For example:

$ curl "https://stamps.co.id/api/400"

Example response:

HTTP/1.0 400 BAD REQUEST
Content-Type: text/html; charset=utf-8
Date: Thu, 21 Aug 2014 01:50:39 GMT
Server: WSGIServer/0.1 Python/2.7.6

Bad request - 400

4. Error 401

Allowed method: GET & POST

Almost all of Stamps’ and OMNI API calls require a token for authentication. If you do not provide the correct token, the respective API(s) will return an Error 401 UNAUTHORIZED.

If an invalid token is used:

HTTP/1.0 401 UNAUTHORIZED
Vary: Accept
Content-Type: application/json
[Redacted Header]

{"detail": "Invalid token"}

5. Error 403

Allowed method: GET & POST

Stamps and OMNI require that you call them using HTTPS due to the lack of security with HTTP. If you are using HTTP instead of HTTPS in your API calls, the respective API(s) will return an Error 403 FORBIDDEN.

If HTTP is used instead of HTTPS:

HTTP/1.0 403 FORBIDDEN
Vary: Accept
Content-Type: application/json
[Redacted Header]

{"detail": "Please use https instead of http"}