Download the PHP package nameblitz/epik-api without Composer

On this page you can find all versions of the php package nameblitz/epik-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of nameblitz/epik-api

Informations about the package epik-api

Epik API Library

This library is for using version 2 of the Epik.com REST API with your PHP application. It has been developed by NameBlitz for its own use and is made avalible to the public under the MIT License, see the LICENSE file for more detials.

Installation

To install the library, it is highly recommended that you use Composer in your project. If you aren't using Composer yet, it's really simple!

Here's how to install composer:

Once composer is installed all you have to do is run this:

If you opt not to use composer, you can still manually download and load this library, see Usage below.

Requirements

This library requires PHP 5.6 or greater with the CURL, JSON, and MBSTRING extensions.

Usage

You should use the Composer autoloader in your application to automatically load your dependencies. Make sure to include the following at the start of your script:

If you aren't using composer, and you really should, you can also manually load this library using:

Authenticating

Next, before making your first API call you have to provide your API user signature by calling:

Login to your Epik.com account API setting at https://registrar.epik.com/account/api-settings/ to generate and see your signature and add the IP(s) you will be using to connect to the API. You will use the signature listed under "User API Settings" for your user signature and the signature listed under "Marketplace API Settings" as your marketplace signature.

Most calls authenticate using your userSignature however the Liquidate API calls use your marketplaceSignature. Therefore it is safe to only provide your userSignature if you are NOT using Liquidate methods or only provide your marketplaceSignature if you are only calling liquidate methods. If you are unsure just set both and this library will make sure to use the correct one for each call.

Error Handling

If the Epik API returns an error, this library will throw it as a PHP Exception. Therefore, when attempting to make an API call, be sure to use a try/catch block to gracefully handle any errors that occur.

All error codes and error messages shown are the exact codes and messages returned by the Epik API.

For example:

Documentation

For specific usage details, check out the /docs folder for detailed documentation for each method currently supported by this library.

Semantic Versioning

This library makes use of semantic versioning. This means the version number will be represented as: MAJOR . MINOR . PATCH

The Major Version will reflect the version of the Epik API the library is designed to work with (This library starts at version 2 as it DOES NOT SUPPORT version 1 of the Epik API in any way). The Minor Version represents supporting newer features later added to the same version of the Epik API. And the Patch Version represents bug and/or security fixes to the major/minor version identified as needed.

By using this you can make better use of Composer to update this library with new patches or even adding new features while preventing breaking changes from being introduced. For example if you want to get all updates via composer for version 2 of the Epik API you can use:

Or if you don't want new features when using composer update you can still get bug and security patches by using:

Support

NameBlitz uses and is actively supporting this library. Issues and pull requests for this project are welcomed and encouraged.

All versions of epik-api with dependencies

PHP Build Version
Package Version
Requires php Version >=5.6.0
ext-curl Version *
ext-json Version *
ext-mbstring Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package nameblitz/epik-api contains the following files

Loading the files please wait ....