APIs and webhooks are important to operations because they streamline communication between different systems, enabling automation and improving efficiency. This allows your operations to be seamless, scalable, and cost-effective.
Before moving forward, we will have to understand what are webhooks and APIs:
-
Webhooks: Webhooks are used to establish a connection between two different apps and transmit the information that you require.
- Webhook Endpoint: A webhook endpoint is a URL that receives webhook event notifications and can trigger an action based on the payload sent in the message
-
API: APIs, or Application Programming Interfaces, are sets of rules and protocols that allow different software applications to communicate with each other.
- API Key: A unique identifier used to authenticate requests associated with a project or application when accessing an API
There is a webhook/API connection for each important category on PayDocker. These categories include Token, booking, invoice, check-out, and authorization.
Webhooks
URL: https://dashboard.paydocker.com/integration-webhooks
- (1) Add endpoint - webhook endpoint is a URL that receives webhook event notifications and can trigger an action based on the payload sent in the message.
- Read - Is used for webhook URL from the application you want to send data to.
- Push - way to push information to your own servers, in real-time, as your data is created and modified, without the disadvantages of polling.
-
Pull - The act of pulling information from another system. Pulling requests are made by a client, while webhook requests are made by a server.
- (2) More actions - users can select more functions when they click the 3 buttons. It depends on the user what they need to update on the endpoint.
Some of the functions available include:
1. Update or disable the webhook endpoint
You may edit the URL by clicking update details. From there, you can edit the list of enabled_events , and the status of your endpoint. You can do some by filling out this simple form:
(1)- Events - user can select what they need to implement an action to the endpoint
(2)- Select event - selecting action in the drag button
(3)- Add - after selecting an event to be implemented in the endpoint, click add.
(4)- Update - after selecting the action, click update to reflect the action in the endpoint.
2. Set an expiry date for the API key
Click Expire to set the timer for the expiration of the authentication key and roll the API key.
(1) Expiration- user will set an expiration date for the authentication key.
- Now
- 1 hour
- 2 hours
- 24 hours
(2) Input password- is used for server-to-server communication
(3) Roll API key- is used for server-to-server communication
API Keys
Each API Keys has been generated on your PayDocker account and should be kept confidential. You can access your API keys by clicking the link below.
URL: https://dashboard.paydocker.com/integration-keys
Here are the details of this view:
(1) Roll IP key - Set the expiration of the key here. You can set the expiration time up to 24 hours.
(2) Reveal key- when the user clicks the reveal key, it will show the secret key of the authentication of the token keys.
(3) Publishable key- is used for accessing data in public data
(4) Secret key- is used for server-to-server communication
Logs
Lastly, you can see each trigger of the API. Logs contain information for each API push for your reference. Each push will be classified as succeed or fail, and the details of the entry.
Accessing Logs
URL: https://dashboard.devpaydocker.cloud/integration-logs
1. Access this page by clicking on Integration (1), then Logs (2) in the left panel.
These categories are typically used to organize and manage log entries according to their status, making it easier for a user to monitor and troubleshoot the system or application to which these logs pertain.
| Category | Details |
| All | It shows all the transactions |
| Succeeded | Filters the logs to show only those that have completed successfully. |
| Failed | Filter the logs to show only the ones that did not complete successfully or encountered some error. |
In cases wherein you are searching for a specific API call, you are able to filter the search for your convenience.
- Logs Filter → you may narrow down the type of logs to NORMAL LOGS or SYNC LOGS.
- Date Range Filter → you may select a date range to narrow down your search.
- API Endpoint URL Filter → you can narrow your search by entering a specific endpoint url.
- Category → you can search by choosing a specific category.
- Method → you can search by choosing a specific method.
- Event→ you can search by choosing a specific event.
Status
Below are the different status of the API call done.
- 200OK (1) — if this message is stated, that means that the API call done is all okay.
- 400ERR (2) — if this message is stated, that means that the API call has failed.
Details
After selecting the specific API call, on the right-hand side of the page, you will be able to see the details of the call done. See the below image for your reference: