API Reference

API Authentication

  1. To use the API you must have an active Aeropost account.
    1. For development environment: You can create your account here https://app-dev.aeropost.com/signupBusiness.
    2. For production environment: If you don’t have an account yet, please contact your Aeropost representative.
  2. Share your account number and gateway/country with your Aeropost representative, and they will provide you access to your client_id and client_secret.
  3. To get your access_token or bearer token, you can use this CURL as example:
  • Development {{base_auth_url}}: https://ap-idp-dev-stage.aeropost.com
  • Production {{base_auth_url}}: https://account.aeropost.com
curl --location '{{base_auth_url}}/auth/realms/myaccount/protocol/openid-connect/token'
--header 'Content-Type: application/x-www-form-urlencoded'  
--header 'Authorization: Basic {{base64(client_id:client_secret)}}'
--data-urlencode 'grant_type=password'  
--data-urlencode 'scope=openid email'  
--data-urlencode 'username={{your_account_number}}'  
--data-urlencode 'password={{your_account_password}}'  
--data-urlencode 'gateway={{your_country_gateway}}'
  • To create your Authorization header get a base64 string using your client_id and client_secret concatenated with a colon (:).
  • Response example:
{
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJKMWlabFoxZ1dxSkg1S1FVOE5qTVpYUk1WYnMtX1E1dE1vUXQzMm9nVzA0In0.eyJleHAiOjE3MTQ4NTM2MDYsImlhdCI6MTcxNDc2NzIwNiwianRpIjoiOTkyNjg4NzktOTliNS00M2U0LWE4NTMtMzI0NmJjODNjMmJlIiwiaXNzIjoiaHR0cHM6Ly9hcC1pZHAtZGV2LXN0YWdlLmFlcm9wb3N0LmNvbS9hdXRoL3JlYWxtcy9teWFjY291bnQiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiZjoxM2EyMzA5Ny1iM2QxLTRmZmQtYTBkZC1jMzI1M2NhYzcxYzk6NDY5NjUxLVNKTy05IiwidHlwIjoiQmVhcmVyIiwiYXpwIjoibXlhY2NvdW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjkxOGQxZjI1LWYwZWMtNDQ1Zi1iMTI2LWI4NWFiNjhjMTU1OSIsInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJvZmZsaW5lX2FjY2VzcyIsInVtYV9hdXRob3JpemF0aW9uIl19LCJyZXNvdXJjZV9hY2Nlc3MiOnsiYWNjb3VudCI6eyJyb2xlcyI6WyJtYW5hZ2UtYWNjb3VudCIsIm1hbmFnZS1hY2NvdW50LWxpbmtzIiwidmlldy1wcm9maWxlIl19fSwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6IjkxOGQxZjI1LWYwZWMtNDQ1Zi1iMTI2LWI4NWFiNjhjMTU1OSIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwicHJlZmVycmVkX3VzZXJuYW1lIjoiU0pPLTkiLCJsb2NhbGUiOiJlbiIsImVtYWlsIjoiam51bmphckBhZXJvcG9zdC5jb20ifQ.HJB6XsKS5AUlgUL4yIq7l67nacGz4zYesFXnaJmtRRuOjXC7ln3rPO64TgDe8EcQa2pKnmEJO4lV0tQ3FHSG8wxwUeFrkJrfbpkZFec9cpwonJtmFwFDtumR_ybwqKhbDBdIc0r1lA5-0slVdBao5OAh0cnm2Yy1xhpqW2LWJwa3Me9CpEzxQFaEFBHbgGBadY_EWpyGx5uYiYTi1jMF-slMgAr09TSQYRhgznZAlGXA84RkfcpsBFJsmwuSIcE4kWkDZErS1ssHYwNZCEcWHshh1d8GNcftti0hxIcGohKHdxFQkRlLP-OgMfHMcqvo0SS2PF64ZkfOrNY2eEUklw",
    "expires_in": 86399,
    "refresh_expires_in": 7775999,
    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIyZjY5NDlkNi05NjgwLTQ5NmMtOGU3OS01NjVhY2U4ZTU5MTUifQ.eyJleHAiOjE3MjI1NDMyMDYsImlhdCI6MTcxNDc2NzIwNywianRpIjoiMmU5NWQ3YzYtNjI4MS00MzUxLTg2MmEtNDU1Y2FjNjYzNzdkIiwiaXNzIjoiaHR0cHM6Ly9hcC1pZHAtZGV2LXN0YWdlLmFlcm9wb3N0LmNvbS9hdXRoL3JlYWxtcy9teWFjY291bnQiLCJhdWQiOiJodHRwczovL2FwLWlkcC1kZXYtc3RhZ2UuYWVyb3Bvc3QuY29tL2F1dGgvcmVhbG1zL215YWNjb3VudCIsInN1YiI6ImY6MTNhMjMwOTctYjNkMS00ZmZkLWEwZGQtYzMyNTNjYWM3MWM5OjQ2OTY1MS1TSk8tOSIsInR5cCI6IlJlZnJlc2giLCJhenAiOiJteWFjY291bnQiLCJzZXNzaW9uX3N0YXRlIjoiOTE4ZDFmMjUtZjBlYy00NDVmLWIxMjYtYjg1YWI2OGMxNTU5Iiwic2NvcGUiOiJvcGVuaWQgZW1haWwgcHJvZmlsZSIsInNpZCI6IjkxOGQxZjI1LWYwZWMtNDQ1Zi1iMTI2LWI4NWFiNjhjMTU1OSJ9.iK3LooY0I3RcoiMJ9xuUaVmTIAaILkWX2KYsPmstoj0",
    "token_type": "Bearer",
    "id_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJKMWlabFoxZ1dxSkg1S1FVOE5qTVpYUk1WYnMtX1E1dE1vUXQzMm9nVzA0In0.eyJleHAiOjE3MTQ4NTM2MDYsImlhdCI6MTcxNDc2NzIwNywiYXV0aF90aW1lIjowLCJqdGkiOiJhYzViZDdjZC1jYWQzLTQwNzQtYmJlOS0zZGY2YmM3MTMyYmEiLCJpc3MiOiJodHRwczovL2FwLWlkcC1kZXYtc3RhZ2UuYWVyb3Bvc3QuY29tL2F1dGgvcmVhbG1zL215YWNjb3VudCIsImF1ZCI6Im15YWNjb3VudCIsInN1YiI6ImY6MTNhMjMwOTctYjNkMS00ZmZkLWEwZGQtYzMyNTNjYWM3MWM5OjQ2OTY1MS1TSk8tOSIsInR5cCI6IklEIiwiYXpwIjoibXlhY2NvdW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjkxOGQxZjI1LWYwZWMtNDQ1Zi1iMTI2LWI4NWFiNjhjMTU1OSIsImF0X2hhc2giOiJSZ3ctZGtkNkp6OTAxUVJkaEJDSW1BIiwic2lkIjoiOTE4ZDFmMjUtZjBlYy00NDVmLWIxMjYtYjg1YWI2OGMxNTU5IiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJTSk8tOSIsImxvY2FsZSI6ImVuIiwiZW1haWwiOiJqbnVuamFyQGFlcm9wb3N0LmNvbSJ9.kDn0-9lEZgyxGR2q_GunAvM9owMzMoWswCA-htDnyKqpdOFaPeI7ZC-z1vMhp-9FhlL-Wc4TI7p7_ZDNN3UQLIveha_hGWcuE973QUlWKlfl0Lkrko9qK1ET_AEnaWGT6tzrjdxVH8zgij8HPz4lk0TB6vgT0EjF0ToCW7l2riL3ZQqyE-tCZB-KeVnwJcMijsNcPp6m9AVljxcgOI5PQ2XSWjQiyjVqbVjEebUoznrPdNeB1GO1JTew7nXsWfFPYYjRMhdshYx_GNocSl4addMmbjYIZ3kTnp58-tmFjYFXlKFCUUfMCkAIBeIx9gbkrChR-yAM4Kz6hqe7hgvXEw",
    "not-before-policy": 1697161643,
    "session_state": "918d1f25-f0ec-445f-b126-b85ab68c1559",
    "scope": "openid email profile"
}
  1. Once you get your access_token you are ready to create your first request to our API using these base endpoints:
  • Development: https://myaccountexternal-devel.aeropost.com
  • Production: https://apmyaccountexternal-api.aeropost.com