> ## Documentation Index > Fetch the complete documentation index at: https://altostrat.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # Generate a signed coupon URL > Creates a temporary, signed URL that can be used to retrieve the list of valid coupons generated by a specific schedule. This is useful for distributing coupons to third-party systems without exposing API keys. The URL is valid for 24 hours. ## OpenAPI ````yaml /api/en/captive-portal.yaml get /captive/instances/{instanceId}/coupon-schedules/{scheduleId}/generate_url openapi: 3.0.3 info: title: Altostrat Captive Portal API version: 1.0.0 description: >- The Altostrat Captive Portal API is the microservice responsible for managing user authentication, access control, and branding for guest Wi-Fi networks. It acts as the control plane for guest network experiences on MikroTik devices within the Altostrat SDX platform, integrating with network automation to dynamically manage user sessions and access policies. This API allows you to programmatically manage: - **Instances:** A complete configuration for a captive portal, including its appearance (theme), authentication method (OAuth2 or coupon-based), and session rules. - **Auth Integrations:** Reusable configurations for third-party identity providers (e.g., Google, Azure AD) used in OAuth2 authentication strategies. - **Coupons & Schedules:** Time-limited access codes and the automated schedules that generate them for coupon-based guest access. - **Walled Garden:** Granular rules defining which domains or IP addresses users can access *before* authenticating, essential for identity provider logins. Developers use this API to programmatically create, configure, and manage bespoke guest Wi-Fi experiences across their entire network of sites. servers: - url: https://v1.api.altostrat.io description: Altostrat Production API security: - bearerAuth: [] tags: - name: Captive Portal Instances description: >- Manage captive portal configurations, including themes, authentication strategies, and associated sites. - name: Auth Integrations description: >- Configure third-party Identity Providers (IDPs) for OAuth2-based authentication. - name: Coupons description: Generate and manage single-use access coupons for guest networks. - name: Coupon Schedules description: Automate the generation of access coupons on a recurring schedule. - name: Walled Garden description: Control which destinations users can access before authentication. - name: Site Users description: >- View and manage users who have authenticated through the captive portal at a specific site. - name: Public Coupon URLs description: Signed public URLs for coupon schedule exports. paths: /captive/instances/{instanceId}/coupon-schedules/{scheduleId}/generate_url: get: tags: - Coupon Schedules summary: Generate a signed coupon URL description: >- Creates a temporary, signed URL that can be used to retrieve the list of valid coupons generated by a specific schedule. This is useful for distributing coupons to third-party systems without exposing API keys. The URL is valid for 24 hours. operationId: generateSignedCouponUrl parameters: - $ref: '#/components/parameters/instanceId' - $ref: '#/components/parameters/scheduleId' responses: '200': description: A temporary signed URL. content: application/json: schema: type: object properties: signed_url: type: string format: uri description: >- A temporary URL (valid for 24 hours) to access the list of valid coupons from this schedule. example: >- https://v1.api.altostrat.io/captive/coupons?sid=c3ab8c9b...&expires=... '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' components: parameters: instanceId: name: instanceId in: path required: true description: The unique identifier for the captive portal instance. schema: type: string format: uuid example: 9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c scheduleId: name: scheduleId in: path required: true description: The unique identifier for the coupon schedule. schema: type: string format: uuid example: 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d responses: Unauthorized: description: >- Unauthorized - The request requires authentication, but no valid credentials were provided. Ensure your API key is correct and included in the 'Authorization' header. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: >- Not Found - The requested resource could not be found. Check that the provided ID is correct. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' schemas: ErrorResponse: type: object properties: type: type: string description: A broad category for the error (e.g., 'invalid_request_error'). example: invalid_request_error code: type: string description: A short, unique string identifying the specific error. example: parameter_missing message: type: string description: A human-readable description of what went wrong. example: The 'name' parameter is required for this request. doc_url: type: string description: >- A direct link to the documentation page for this specific error code. example: https://docs.altostrat.io/errors/parameter_missing securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- API Key authentication. Provide your token in the 'Authorization' header. Example: `Authorization: Bearer ` ````