Worldwide (English)
Türkiye (Türkçe)
Getting StartedAccess and Authorization
This stage details how to perform access and authorization for external and internal API usage.
External API Usage
- It is mandatory to create an "API Credential" to access the external API.
Internal API Usage
- There is no requirement to create an API ID for the internal API.
Creating an API Credential
Important Reminder:
API usage is possible with WISECP version 3.1.7. Therefore, make sure that your WISECP version is at least 3.1.7 before using the API. Otherwise, no API related functions will be displayed in your administration area.
API usage is possible with WISECP version 3.1.7. Therefore, make sure that your WISECP version is at least 3.1.7 before using the API. Otherwise, no API related functions will be displayed in your administration area.
- Go to "Settings > General" from the menu in your WISECP Administration area.
- Find the "API" tab and click on it.
- Click on the "Create" button to start the process of creating a new API Credential.
Name:
- Give your API Credential a descriptive name (can contain uppercase, lowercase letters, numbers, spaces, special characters).
Allowed IP addresses:
- This field is optional; If you want to fill it in, the IP addresses that can access the external API must be entered one under the other.
Permissions:
- You need to allow at least one action in this field, more information about what actions do can be found in the "Actions" document.
After entering the required information, click on the "Create" button. Then you can copy the generated API key to the clipboard by clicking the "Copy" button that appears on the page.
Defining the API Key
- When making your API requests, place your API key under "Apikey" in the "Header" section of the HTTP request.
- You also need to specify "application/json" as the data type under the "Content-Type" heading.
API URL
- To find out the URL of your API, again go to "Settings > General > API" tab. The API URL will be displayed on the relevant page.
- Usually the URL format is displayed as follows: https://example.com/api/ OR https://example.com/index.php/api/
- For a specific API action, you can get the full endpoint information by adding "/action_group_name/action_name" to the end of the API URL.
By following these steps, you can safely complete your API access and authorization processes.
Sample cURL Request
curl --location 'https://example.com/api/Clients/ValidateClient' \
--header 'Content-Type: application/json' \
--header 'Apikey: Your API Key' \
--data-raw '{
"email": "[email protected]",
"password": "test123"
}'