Konaplate logo

Guidelines

Credentials

  • When creating a project of KONA PLATE, it means the project key and certificate issued for API testing.
     

1. Crypto Key

  • Crypto Key
    This key is used to encrypt data when there is sensitive information about input/output data among linked APIs.
  • Generate Crypto Key
    For the project requested by the affiliate, an encryption key is issued if there is an API that requires data encryption among the affiliate's API when the manager approves it.
  • Crypto Key Type
    - Server Key: Affiliates use the server's public key for data encryption according to the encryption method of the API.
    - Client Key: The affiliate uses the client's private key for data decryption according to the encryption method of the API.

     

2. Project Key

  • For the validity of the API, the affiliate must set the required items in the API Header using the issued project key.
    Depending on the API linkage method, the project key to be used will vary, so the appropriate project key must be selected and used according to the API linkage purpose.
  • Generate project key
    When the manager approves the project requested by the member, the project key required for API linkage is issued.
  • Project Key Status
    The status of the authentication key may be divided into an active, inactive, and discarded state. Disabled project keys can be activated, but discarded project keys cannot be changed to disabled and enabled.
  • Project Key Type
    Depending on the type of API linkage, it can be divided into a sandbox key, a UAT server key, and an SI key.
    - Sandbox key: This key is for performing interlocking test with test data (input and output data) provided by the KONA PLATE developer site. 
    - System Integration (SI) key: The key used for system integration, not for sandbox or UAT authentication. 
    - UAT server key: A key used for UAT authentication. When an affiliate requests UAT certification, it will be given a UAT certification key through the KONA PLATE manager.
    - Access key: The access key is a key that points to a secret key, and the corresponding key must be set in the X-KM-Access-Key of the API Header.
    - Secret key: A key mapped to an access key, which is a key used to generate Hmac. The Hmac result value must be set in the X-KM-Tran-Token of the API Header.