Which method should you use? Find out more information about how to connect to GitShare.

To access the GitShare API, you must authenticate yourself. GitShare supports two methods of authentication, both are useful for different scenarios.

In either case, it is important to use SSL when calling the GitShare API. This ensures that communication with our servers is secure.

Basic Authentication

Basic authentication is a simple method that allows you to generate an API key and password. Basic authentication allows you to access your own account via the GitShare API.

This is useful when...

  • you need to automate some repetitive task using a script.
  • you need to integrate with some other system or software that you use.
  • you are building a service, but your users don't need to know you use GitShare.

To get started with Basic Authentication, generate an API key.


OAuth authentication is useful when you are writing a service that you want to make available to other GitShare users. OAuth allows you to register your application with GitShare. Once you register, you obtain a client access token that can be used to ask a GitShare user for access to their account. Once access is granted, you can call the GitShare API on behalf of that user, to read and write their files or to perform any action that user can perform. OAuth allows you to interact with someone else's account.

This is useful when...

  • you want to extend GitShare in some way.
  • you are building a service, and want your users to "bring their own storage" with them.
  • you want to give your users many storage platforms to choose between when importing or exporting data.

To get started with , register your application.

Not Using Our SDK

This article is written for users that are not using one of the current SDKs. When using one of our SDKs, the correct fields and values should automatically be sent. The SDK will also store tokens/secrets and includes those with calls to the API.