Kosha Passthrough Connector

The passthrough connector APIs allow you to perform 'RESTful' operations such as reading, modifying, adding or deleting data from the service of your choice. The APIs also support Cross-Origin Resource Sharing (CORS).

It currently supports 2 forms of authentication.

1. Basic Auth (i.e., std username/password, sent via request headers)
2. API Keys (sent via request headers)
3. HMAC Authentication - https://en.wikipedia.org/wiki/HMAC
4. OAuth2 - https://en.wikipedia.org/wiki/OAuth

This Connector API exposes REST API endpoints to perform any operations on any third-party API in a simple, quick and intuitive fashion.

It describes various API operations, related request and response structures, and error codes.

Build

To build the project binary, run

    go build -o main .

Run locally

To run the project, simply provide env variables to supply the API key and Freshdesk domain name.

go build -o main .
API_KEY=<API_KEY> DOMAIN_NAME=<DOMAIN_NAME> ./main

This will start a worker and expose the API on port 8012 on the host machine

Swagger docs is available at https://localhost:8012/docs

Generating Swagger Documentation

To generate swagger.json and swagger.yaml files based on the API documentation, simple run -

go install github.com/swaggo/swag/cmd/swag@latest
swag init -g main.go --parseDependency --parseInternal

To generate OpenAPISpec version 3 from Swagger 2.0 specification, run -

npm i api-spec-converter
npx api-spec-converter --from=swagger_2 --to=openapi_3 --syntax=json ./docs/swagger.json > openapi.json