Introduction
Welcome to the official PoK API documentation site. Here you will find comprehensive information on integrating your systems with our platform, including digital credential issuance and information gathering mechanics.
Prerequisites
Registering in the platform is just a matter of creating a new user. From that point, you can start emitting free certificates.
To emit NFT certificates, however, you have to get your hands onto some POKCREDITs. At this point, to do this please contact sales. This is, at the time, also required for emitting on our sandbox.
Environments
Our live API is hosted over HTTPS. We also provide a sandbox environment so you can test out your integration before going live.
| environment | endpoint | polygon network | certificates contract | pokcredits contract |
|---|---|---|---|---|
| live | https://api.pok.tech/ | MAINNET | 0xe85db973B210d98213516e6973D4c61E16711331 | 0x0c8de25406bBc3d54d91200C4D87ce84A5186235 |
| sandbox | https://api.credentity.xyz/ | AMOY | 0x898Ccc0fA04e32EC0e35732a8ead3fB8553A0834 | 0x51dfB3Ada7f98A9abcEDc391464004d6A4A30202 |
Details on available endpoints, expected requests, responses, etc. can be found at the API specification.
Webhooks
Integrations can subscribe to event notifications for certificates they issue. These are defined in the user's settings. Details on payloads, integrity and such can be found in the webhooks reference.