1. Home
  2. Docs
  3. Kiwire ( v3 ) – Administrator
  4. Integration
  5. API

API

Kiwire has a built-in API (Application Protocol Interface) that let your application connect and manipulate system and retrieve data from your own developed application. For technical information on the Kiwire API specification, please refer to Kiwire API resource. To access the API module click on Integration > API from the navigation. The configuration screen will be displayed. This includes main and permission for Kiwire platform.





The field and its function description is listed below.

Field Function
Authentication Key A unique authentication key generated.
Permission The permission of API key.
Action

Modules action :

  • To edit the setting of authentication key.
  • To delete the authentication key.




ADD NEW AUTHENTICATION KEY

Click on “Add Authentication Key button and populate the required fields. Fill in the field with relevant information to complete the process.



The field and its function description is listed below.

Field Function
Enable To Enable or disable authentication key.
Permission

The API permission enables you to configure the API permission given to the connecting application. The access granted to API are:

  • Read Only : Read access only
  • Write Only : Write access only
  • Read + Write : Full access
Role Select the role assigned to the API.
Authentication Key Shared secret key between your application and Kiwire when communicate, type in a shared key or use “Generate Key” button to generate one.




EDIT OR DELETE authentication key

Click the edit icon on the listing screen to edit the setting of the authentication key. The edit screen be display which you can edit the setting of the authentication key. Click on the delete icon to delete the authentication key. A prompt will be displayed to ask for your confirmation to proceed to delete the authentication key. Please exercise with caution as this, not a reversible action.