Download the PHP package shayand/api-library without Composer

On this page you can find all versions of the php package shayand/api-library. 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 shayand/api-library

Informations about the package api-library

Using the NextLead API Library

Requirements

Shayand Setup

The API must be enabled in NextLead. Within NextLead, go to the Configuration page (located in the Settings menu) and under API Settings enable NextLead's API. If you intend on using Basic Authentication, ensure you enable it. You can also choose which OAuth protocol to use here. After saving the configuration, go to the API Credentials page (located in the Settings menu) and create a new client. Enter the callback/redirect URI that the request will be sent from. Click Apply then copy the Client ID and Client Secret to the application that will be using the API.

Authorization

Obtaining an access token

The first step is to obtain authorization. NextLead supports OAuth 1.0a and OAuth 2 however it is up to the administrator to decide which is enabled. Thus it is best to have a configuration option within your project for the administrator to choose what method should be used by your code.

Using Basic Authentication Instead

Instead of messing around with OAuth, you may simply elect to use BasicAuth instead.

Here is the BasicAuth version of the code above.

Note: If the credentials are incorrect an error response will be returned.

API Requests

Now that you have an access token and the auth object, you can make API requests. The API is broken down into contexts.

Get a context object

Supported contexts are currently:

See the developer documentation.

Retrieving items

All of the above contexts support the following functions for retrieving items:

Creating an item

Editing an item

Deleting an item

Error handling

Unit tests

Configure the unit tests config before running the unit tests. The tests fire real API requests to a NextLead instance.

  1. Copy /tests/local.config.php.dist to /tests/local.config.php.
  2. Open the API tester in the browser like http://localhost/api-library/apitester/index.php
  3. Fill in the URL of your NextLead instance.
  4. Click Submit to store the URL to the session.
  5. Fill in one of the OAuth credentials and authorize.
  6. Open the $_SESSION array and copy the 'access_token' to the local.config.php file.
  7. Then run vendor/bin/phpunit to run the tests.

Modify this command to run a specific test: vendor/bin/phpunit --filter testCreateGetAndDelete tests/Api/NotesTest.php

Modify this command to run all tests in one class: vendor/bin/phpunit --filter test tests/Api/NotesTest.php

All versions of api-library with dependencies

PHP Build Version
Package Version
Requires php Version >=5.3.7
ext-curl Version *
psr/log Version ~1.0
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 shayand/api-library contains the following files

Loading the files please wait ....