Sign In

Authentication

Our API uses API keys to authenticate requests. Test mode secret keys have the prefix gpc_test_ and live mode secret keys have the prefix gpc_live_.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Custom Header

When establishing a connection to our API, you will need your API key. Here's how to add the key to the request header using cURL:

GET /ping

curl https://shipping.webhooks.gpcoservices.com/ping \ -H "GPC-Api-Key: {key}" Copy

Query Params

Sending your API key through the custom GPC-Api-Key header is preferred, however, if you are unable to set headers on your request you add the key to the query parameters. Here's how you could achieve this using cURL:

GET /ping

curl https://shipping.webhooks.gpcoservices.com/ping?api_key={key} Copy