Zenkipay Token

Introducción

Zenkipay API está diseñada sobre REST, por lo tanto encontraremos que las URL están orientadas a recursos. Además se utilizan códigos de respuesta HTTP para indicar los errores de la API.

Es necesario tener una cuenta en Zenki, de lo contrario será necesario que registres el comercio en zenki.fi. La cuenta de Zenki debe estar enrolada al producto de Zenkipay y contar con al menos con un pago de prueba exitoso.

Seguridad

Para realizar peticiones a Zenkipay API de forma exitosa se requiere de lo siguiente:

Autorización HTTP mediante el esquema Bearer Token.
Credenciales de acceso para Zenkipay API.

Generar credenciales de acceso

Para generar las credenciales de acceso, dirígete al menú de Zenkipay en Configuración -> Seguridad, en la sección de Credenciales de acceso para Zenkipay haz clic en el botón de “Generar”.

config

Como resultado obtendrás las credenciales necesarias para realizar peticiones a Zenkipay API.

Screenshot

API Token

Como primer paso es necesario consumir el EndPoint de autenticación para obtener el Bearer Token y de esta forma puedas consumir los servicios autenticados de Zenkipay API. En este punto es cuando usaras las credenciales de acceso a Zenkipay API que obtuviste anteriormente.

💡 Para la petición de la generación del Token, la llave de acceso es el username y la llave secreta es el equivalente a la contraseña.

username (Llave de acceso): 8dc469a1de4b42759c07c4f2bd6c03f4
password (Llave secreta): F7E85E907A0DD5FC4B6D6D9E0EE6B0E147BD901ADF66AC24

ENDPOINT

 POST  https://api.zenki.fi/auth/

Headers
- Accept: application/json
- Content-Type: application/x-www-form-urlencoded
Body [urlencoded]
- client_id : zenkipay-api (string)
- username : 8dc469a1de4b42759c07c4f2bd6c03f4 (string | required)
- password : F7E85E907A0DD5FC4B6D6D9E0EE6B0E147BD901ADF66AC24 (string | required)
- grant_type : password (string)
Atributos de respuesta
- access_token : (string)
- expires_in : (number)
- refresh_expires_in : (string)
- token_type : (number)
- not-before-policy : (number)
- session_state : 1 (number)
- scope : (string)

cURL

1
2
3
4
5
6
7
8


curl --request POST \
     --url https://api.zenki.fi/auth/ \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data client_id=zenkipay-api \
     --data grant_type=password \
     --data username=8dc469a1de4b42759c07c4f2bd6c03f4 \
     --data password=F7E85E907A0DD5FC4B6D6D9E0EE6B0E147BD901ADF66AC24.

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
    "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwenJMTnEwbzBab1R4NTlaeWVPaTI1RGxZLWl6cV91SVFSLThWS0RaWjlFIn0.eyJleHAiOjE2NjE3ODEyMzcsImlhdCI6MTY2MTc3OTQzNywianRpIjoiMjRmNDI4YWItMTdjNy00MjUxLTg2YzMtOTUxZTQ1ZTMyMmUzIiwiaXNzIjoiaHR0cHM6Ly9kZXYtYXV0aC56ZW5raS5maS9hdXRoL3JlYWxtcy9wYnciLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiZWQ3ZWQ1ZmMtZjBmNy00OWEwLWEwNWYtNWNiZTFkMjZkYTlkIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiemVua2ktcGF5Iiwic2Vzc2lvbl9zdGF0ZSI6IjM1NWFmMTgzLTg3MTgtNDRmYS1hZTA3LTVlMWMxOWQ3ZDkwNSIsImFjciI6IjEiLCJhbGxvd2VkLW9yaWdpbnMiOlsiIl0sInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJhcGkiLCJhcGlfemVua2lwYXkiLCJkZWZhdWx0LXJvbGVzLW1ldGFiYW4iXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6InByb2ZpbGUgZW1haWwiLCJzaWQiOiIzNTVhZjE4My04NzE4LTQ0ZmEtYWUwNy01ZTFjMTlkN2Q5MDUiLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwibmFtZSI6IlJlYWwgTWFkcmlkIEZDIFJlYWwgTWFkcmlkIEZDIiwicHJlZmVycmVkX3VzZXJuYW1lIjoiOGRjNDY5YTFkZTRiNDI3NTljMDdjNGYyYmQ2YzAzZjQiLCJnaXZlbl9uYW1lIjoiUmVhbCBNYWRyaWQgRkMiLCJsb2NhbGUiOiJlbiIsImZhbWlseV9uYW1lIjoiUmVhbCBNYWRyaWQgRkMiLCJlbWFpbCI6IjhkYzQ2OWExZGU0YjQyNzU5YzA3YzRmMmJkNmMwM2Y0In0.fFWp1vCaHTbdBO-jBqDhhtIaDOve4fnIlIPfoYLRZDAKfvuFjyYrShdRADS7fGgXdqPBDDElil551FmhnerGz5K5pvMIPDlnZqpVu2EJbqy3ueEM6fQVrFUWPCw5B6jczPqugAoK73VkURvNA22X9vUIUBYAT9snLeJNFW1duMF3JIm3V7oJK_zFBsNs_YH0DA7Zn1j1LFEm5fqcsUXxTLY_A7Jw1CMIkX3EookiC-xayCACynbE2USnAddmxWCWRv0ZblbmscKYoKWvA9Kra1UoOEyRknzMq2JQ9-Sco2mnK6Bagg7FvORF5JpBQ-IIxJqkZdoP2_HH2VhBEyQ0Og",
    "expires_in": 1800,
    "refresh_expires_in": 3600,
    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJkN2U1ZDMzYy00ZGExLTQ4ZWUtYTJhMi02ZjhlNjg2NTcxNzcifQ.eyJleHAiOjE2NjE3ODMwMzcsImlhdCI6MTY2MTc3OTQzNywianRpIjoiNjM0MDMyZjgtNjZlMC00ZjJkLTg1ZTMtMmJiYTc4MzBmMTNhIiwiaXNzIjoiaHR0cHM6Ly9kZXYtYXV0aC56ZW5raS5maS9hdXRoL3JlYWxtcy9wYnciLCJhdWQiOiJodHRwczovL2Rldi1hdXRoLnplbmtpLmZpL2F1dGgvcmVhbG1zL3BidyIsInN1YiI6ImVkN2VkNWZjLWYwZjctNDlhMC1hMDVmLTVjYmUxZDI2ZGE5ZCIsInR5cCI6IlJlZnJlc2giLCJhenAiOiJ6ZW5raS1wYXkiLCJzZXNzaW9uX3N0YXRlIjoiMzU1YWYxODMtODcxOC00NGZhLWFlMDctNWUxYzE5ZDdkOTA1Iiwic2NvcGUiOiJwcm9maWxlIGVtYWlsIiwic2lkIjoiMzU1YWYxODMtODcxOC00NGZhLWFlMDctNWUxYzE5ZDdkOTA1In0.MstH5TJjR99Bu7SkCnXXYasfNGHolUv7UdYBrx6Cujk",
    "token_type": "Bearer",
    "not-before-policy": 1646418979,
    "session_state": "355af183-8718-44fa-ae07-5e1c19d7d905",
    "scope": "profile email"
}

Errores

Codigo	Descripción	json
401	La petición (request) no ha sido ejecutada porque carece de credenciales válidas de autenticación para el recurso solicitado.	{ “error”: “invalid_request”, “error_description”: “Missing parameter: username” }