skills.rest
Zoppy-crm
Zoppy-crmOFFICIAL
Explore all skills by this author →
WebsiteGitHub

partners-api

Manage Partners API endpoints with ExternalToken authentication on port 8082.

Updated Mar 1, 2026
Search Tags:#authentication#routing#validation#swagger#partners-api#externaltoken#port-8082
One-click install
npx skills add https://github.com/Zoppy-crm/.github --skill partners-api
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: partners-api
Source: https://github.com/Zoppy-crm/.github/tree/main/skills/backend/partners-api
Command: npx skills add https://github.com/Zoppy-crm/.github --skill partners-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Prevents misconfiguration and developer confusion when working with the separate Partners API environment by documenting its unique routing, authentication, validation, and documentation differences so integrations behave predictably.

Core Features & Use Cases

  • Environment specifics: Clarifies that the Partners service runs on port 8082 and exposes endpoints at the root path (no /api prefix).
  • Authentication handling: Describes ExternalToken header lookup via PartnersExternalAuthMiddleware and how controllers bypass JWT guards.
  • Validation and docs: Notes the permissive validation pipe for forward compatibility and the separate Swagger instance available at /docs.
  • Use case: When adding a new partners endpoint or onboarding an external partner, use these conventions to ensure requests authenticate via ExternalToken, accept extra fields, and are documented under the Partners Swagger.

Quick Start

Use the partners-api skill to explain how to add or modify a partners endpoint that uses ExternalToken authentication, serves on port 8082 with root-level routes, and appears in the separate /docs Swagger.

Frequently Asked Questions about partners-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I configure authentication for a Partners API endpoint using ExternalToken?▼

Partners API endpoints authenticate using the ExternalToken header, handled by PartnersExternalAuthMiddleware. Controllers bypass standard JWT guards and rely on this middleware to validate external partner requests.

Why are my Partners API routes not working without the /api prefix?▼

Partners API routes are exposed at the root path with no /api prefix. The service runs on port 8082, so applying standard /api routing conventions will cause endpoint routing to fail.

What is the permissive validation pipe used for in a Partners API environment?▼

The permissive validation pipe allows partners API endpoints to accept extra fields in requests without throwing errors. This design ensures forward compatibility when external partners send unexpected payload properties.

Where is the Swagger documentation hosted for a Partners API service?▼

Partners API hosts a separate Swagger instance at the /docs path. This is distinct from the main API documentation and specifically covers endpoints served on port 8082.

Can I use JWT authentication for endpoints in the Partners API environment?▼

No, partners API endpoints bypass JWT guards entirely. Authentication is managed exclusively through the ExternalToken header lookup via PartnersExternalAuthMiddleware for external integrations.

What port does the Partners API service run on?▼

The Partners API service runs on port 8082. Configuring the service to run on a different port will violate the environment requirements and break the expected routing behavior.

Related Skills

Explore More Software Engineering Skills→
GolferGeekGolferGeek

LangGraph Development

Create LangGraph workflows as NestJS applications with webhook status tracking.

Community
Intermediate
Zoppy-crmZoppy-crm

e2e-testing

Document Playwright guidelines for end-to-end HTTP API tests.

Official
Intermediate
uzh-bfuzh-bf
41

vercel-react-best-practices

Apply React and Next.js performance best practices to component design and architecture.

Official
Intermediate
codigodoleocodigodoleo
13

superpowers-sage:acorn-middleware

Enforce JWT or custom guard authentication on Acorn routes.

Official
Advanced