endpoint management
Application and Endpoint Management: endpoint management
The role of the endpoints
An endpoint represents a specific client entry point in the application. An application can create Web, iOS, and Android endpoints; each endpoint has its own:
- Public API Key.
- Web source or mobile application signature verification rules.
- Request rate-limit configuration.
- Enable, disable and delete status.
For example, a mall application can create three endpoints: "checkout page Web", "mall client iOS" and "mall client Android".
Limit on the number of endpoints
The current product design allows the creation of up to 10 endpoints for a single application. Once the limit is reached, creation operations are blocked.
When planning the endpoints:
- Use platforms and business portals to distinguish endpoints.
- When independent source verification or rate limiting is required, use an independent endpoint.
- Do not mix the same endpoints in order to differentiate between testing and production; it is recommended to plan applications or endpoints according to the environment.
- Before deleting the endpoints, confirm that the client has stopped using the corresponding Public API Key.
Public API Key life cycle
After creating the endpoints, Geelab will generate an independent Public API Key. It is used for client SDK initialization and identification request authentication.
Usage rules for Public API Key:
- One key corresponds to one endpoint only.
- Web, iOS, and Android should use the Key of their respective platform endpoints.
- Public API Key can appear in client code, but source or signature verification should still be configured.
- Do not use the Public API Key to call the Server API.
- Do not put the Region server key into the client. In the current design, the client-side Public API Key is static and cannot be rotated like the server-side key. If a leak is suspected, immediately deactivate the endpoint or contact Geelab to evaluate regeneration options.
Illustration: Public API Key
Endpoint status
| Status | Impact |
|---|---|
| Enable | Public API Key works normally and identification requests can continue to be processed |
| Deactivate | The Key of this endpoint will stop serving immediately and the request will be rejected; other access ends under the same application will not be affected |
| Deleted | the endpoint is removed from the list, the Key is invalid and cannot be used anymore |
Deactivation is suitable for temporarily suspending a platform or troubleshooting abnormal traffic. Before deleting, confirm that the endpoint's key is no longer referenced by the client, server, monitoring, or documentation.