Package com.dzidzi.api

Interface ApplicationIntegrationApi

public interface ApplicationIntegrationApi

  • Method Summary

    Modifier and Type
    Method
    Description
    ApiTokenResponse
    generateIntegrationKey()
    Generates an api key that will be used to communicate with some endpoint of this application.
    com.dzidzi.service.login.DzidziUserDetails
    getUserDetails(String key)
     
    boolean
    isKeyValid(String key)
    Validates if the key is valid.

  • Method Details

    • generateIntegrationKey

      ApiTokenResponse generateIntegrationKey()
      Generates an api key that will be used to communicate with some endpoint of this application.
      Returns:
      the api key.

    • isKeyValid

      boolean isKeyValid(String key)
      Validates if the key is valid.
      Parameters:
      key - the key to validate

    • getUserDetails

      com.dzidzi.service.login.DzidziUserDetails getUserDetails(String key)