Skip to main content

Endpoints

Endpoints are the communication channels to access the services provided in your applications and through endpoints you expose your application services and data to outside world. When external applications or APIs (e.g., frontend apps, other backend systems) interact with your applications, the touchpoints of this communication are called endpoints.

The endpoints in Altogic are similar to RESTful API endpoints. The following are the key properties of an Altogic endpoint.

  • Method - Similar to Restful API methods, you can specify GET, POST, PUT and DELETE methods when creating an endpoint in Altogic.
  • Path - Similar to RESTful API endpoint path. The root of your endpoint is determined by the environment where your application snapshot is deployed, and it can change from one environment to another. While creating an endpoint, you specify the path part in Altogic. The path is a text value delimited by slash (/) characters. In your path definitions, you can also reference object identifiers using the curly braces { }. For example, the path users/{userId}/addresses/{addressId} denotes an endpoint with userId and addressId object identifiers.

Endpoint path example

  • Routed service - In Altogic, each endpoint is mapped to a service. Altogic invokes the routed service with all the provided input parameters and returns the service response to the request sender when a request is sent to the endpoint.
  • Enabled/disabled - Specifies whether the endpoint is active or not. Only active endpoints can be called; if a disabled endpoint is called, an error message is returned to the caller. This is useful when you work on an endpoint service and temporarily disable it for request handling.
  • API key requirement - You can protect yout endpoints and ask clients to provide a valid API key to invoke the routed service. If an API key is required, the calling party needs to provide a valid API key in a request header called "Authorization."
  • Session requirement - Some endpoints may require a valid session token to invoke the routed service. The session required parameter specifies whether the calling party needs to provide a valid session token when calling the endpoint or not. If a session is required, the calling party needs to provide a valid session token in a request header called "Session."
  • Authorized access groups - When you create an endpoint, you can specify the list of access groups that are allowed to access the service exposed by the endpoint. To use these access groups, sessions need to be enabled for the endpoint, and when creating the user/entity session, the access group key needs to be provided.
info

The endpoint root of your application is determined by the deployed environment. The endpoint root value can change from one environment to another.