terminals

terminals

Provide the APIs that external systems should target to query the master data of citypaq terminals.

• General aspects of Correos APIs
  • Request for access to the API
  • Levels of use
  • Security policies

General aspects Correos APIs

Note: Any client that can make HTTP requests would suffice.

• These are the currently available resources.

-/homepaqs/codHomepaq: Get the information about the location of the terminals.

-/homepaqs: It retrieves all the master information from the terminal based on the filters.

-/homepaqs/manufacturers: Get the manufacturers of the terminals.

-/homepaqs/park: Get all available parks.

-/homepaqs/offices: Get the offices associated with a terminal.

-/homepaqs/terminal/office: Get the terminals associated with an office.

-/homepaqs/updateHighOccupancy: Update the high occupancy index of a terminal.

-/homepaqs/updateMasterData: Update the master information of a terminal.

-/officeAssociations/{operativeUnit}: Get the list of terminals and PUDOs associated with an office in addition to the QR request configuration.

-/historicalTerminal/{idTerminal}: Obtain a history of the data from a terminal.

-/qr: Generate a QR code given an ID and a network.

Request for access to the API

From the Exchange itself, or the access portal of the APIs being used, there will be an option to Request Access. If you do not see that option, it means that this API does not support access requests.

Before a client application is allowed to consume an API, access to the API must be request access to the API. Once access is requested, the request goes through an approval workflow. Once that workflow is completed and approved by the API owner, you will receive an email with the access credentials (if they are defined).

Levels of use

APIs may have different usage levels defined. When requesting access to an API, you will see indications of the usage level (SLA) that the API offers. Please note that some usage levels may have an associated cost.

To understand the usage levels that apply to your API, you can review the API overview.

Security policies

There are several security policies that can be applied to APIs. An API offered by Correos may have none, one, or several of these policies.

In the case of the terminals API, there are client credentials policies, so to consume the resources it is necessary to send the credentials in the request header.

Client ID Enforcement

Client ID application policy: The API expects headers with key/value pairs in its requests.

Before a client application is allowed to consume a protected API under this policy, access to the API must be request access to the API. After an approved contract exists between the client application and the API, each request must include the client application credentials in accordance with the policy configuration.

The credentials will be sent as headers of the request as shown in the following example of a request using curl:

curl "https://api1-intapp.correos.es/logistics/terminals/api/v1/homepaqs" -H "client_id:1234" -H "client_secret:abcd"

Is it possible to consult client_id and client_secret if I have forgotten or lost them?: From the Exchange, or the access portal to the APIs being used, you can consult 'My Applications' and there you can find the access credentials.