Categorygithub.com/automotechnologies/doitpay-go
modulepackage
0.0.0-20231031113204-8beb111ac676
Repository: https://github.com/automotechnologies/doitpay-go.git
Documentation: pkg.go.dev

# README

Doitpay Go SDK

The official Doitpay Go SDK offers an easy and user-friendly method to access Doitpay's REST API in applications coded in Go.

  • Package version: 1.0.0

Getting Started

Installation

Install doitpay-go in your Go application:

go get github.com/automotechnologies/doitpay-go

Place the package in your project directory and include the following in the import:

import doitpay "github.com/automotechnologies/doitpay-go"

Authorization

To utilize the SDK, initialize it with your confidential API key which you can get from the Doitpay Dashboard. If you haven't, you can register for a free Dashboard account here.

dtp := doitpay.NewClient("API-KEY")

Documentation

Access comprehensive API details and sample usages for each of our products by following the links provided below.

Read more at:

Contact Us

[email protected]

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewClient creates a new API client.
NewConfiguration returns a new Configuration object.

# Variables

ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.

# Structs

APIClient manages communication with the Doitpay API API v1.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
GenericDoitpayError Provides access to the body, error and model on returned errors.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.

# Type aliases

ServerConfigurations stores multiple ServerConfiguration items.