> ## 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. # Retrieve coupons from a signed URL > Returns valid coupons for a coupon schedule when called with the signed query string generated by `GET /captive/instances/{instanceId}/coupon-schedules/{scheduleId}/generate_url`. ## OpenAPI ````yaml /api/en/captive-portal.yaml get /captive/coupons 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/coupons: get: tags: - Public Coupon URLs summary: Retrieve coupons from a signed URL description: >- Returns valid coupons for a coupon schedule when called with the signed query string generated by `GET /captive/instances/{instanceId}/coupon-schedules/{scheduleId}/generate_url`. operationId: getCouponsBySignedUrl parameters: - name: sid in: query required: true description: Coupon schedule ID embedded in the signed URL. schema: type: string format: uuid - name: expires in: query required: true description: Signature expiry timestamp from the generated URL. schema: type: integer - name: signature in: query required: true description: URL signature generated by SDX. schema: type: string responses: '200': description: Valid coupons for the schedule. content: application/json: schema: type: array items: $ref: '#/components/schemas/Coupon' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' security: [] components: schemas: Coupon: type: object properties: id: type: string format: uuid description: The unique identifier for the coupon. example: b1c2d3e4-f5a6-b7c8-d9e0-f1a2b3c4d5e6 code: type: string description: The 6-character alphanumeric code for the coupon. example: 8B7W3D expires_at: type: string format: date-time description: The timestamp when the coupon will expire and become invalid. example: '2025-11-01T12:00:00Z' redeemed_at: type: string format: date-time description: >- The timestamp when the coupon was redeemed. Null if not yet redeemed. nullable: true example: null created_at: type: string format: date-time description: The timestamp when the coupon was created. example: '2025-10-29T12:00:00Z' 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 responses: Forbidden: description: >- Forbidden - You do not have permission to perform this action on the requested resource. 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' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- API Key authentication. Provide your token in the 'Authorization' header. Example: `Authorization: Bearer ` ````