SDK Token Management APIs

Comprehensive documentation for managing user SDK tokens within EdfaPay SoftPOS integrations, including token generation, retrieval, and status management. This section provides an overview of the available endpoints and links to their individual API specifications.

Overview

The EdfaPay SDK Token Management APIs provide endpoints for managing SDK tokens associated with users in the EdfaPay platform.

These APIs support the generation and retrieval of user SDK tokens, as well as managing token status. They are intended for integrations that require SDK token provisioning and lifecycle management as part of the EdfaPay SoftPOS ecosystem.

Available APIs

The following endpoints are documented in this section:

APIDescription
Generate User SDK TokenGenerates an SDK token for a user.
Get User SDK TokenRetrieves the SDK token associated with a user.
Switch SDK Token StatusChanges the status of an SDK token.

Refer to each individual API page for its HTTP method, endpoint path, authentication requirements, request parameters, request body, response schema, and applicable access permissions.

Integration Workflow

A typical SDK token management workflow consists of the following operations:

  1. Generate a token — Use the Generate User SDK Token endpoint to request an SDK token for the relevant user.
  2. Retrieve the token — Use the Get User SDK Token endpoint when token information needs to be retrieved.
  3. Manage token status — Use the Switch SDK Token Status endpoint when a token's status needs to be changed.

The exact request sequence and any prerequisites depend on the individual endpoint specifications and the requirements of the integrating application.

Authentication and Access Control

Before integrating these endpoints, review the authentication mechanism and required access level documented for each API.

Ensure that requests use the correct credentials and that the calling user or application is authorized to perform the requested operation.

Do not expose API keys, SDK tokens, or other sensitive credentials in client-side logs, public repositories, or application interfaces.

Token Lifecycle Considerations

When implementing SDK token management:

  • Generate tokens only for the intended user and integration context.
  • Retrieve and handle token information according to the endpoint response schema.
  • Apply status changes only when authorized and required by the integration workflow.
  • Handle unsuccessful requests and validation errors according to the documented API responses.
  • Follow the relevant SoftPOS SDK integration documentation for any token usage requirements.

API Reference

Use the individual endpoint pages in this section for the complete technical specifications:

  • Generate User SDK Token
  • Get User SDK Token
  • Switch SDK Token Status

These endpoint references are the source of truth for request formats, supported parameters, response fields, and endpoint-specific behavior.


Did this page help you?