Git Product home page Git Product logo

dynect-rest-php's Introduction

Dynect-REST-PHP

A simple PHP library for using the Dynect REST API.

About

This is a simple single-file class for accessing the Dynect REST API.

Methods are generally named after the corresponding API endpoint and HTTP verb associated with the desired action:

  • PUT /REST/Zone/ == zoneCreate()

  • DELETE /REST/Zone/ == zoneDelete()

  • PUT /REST/ARecord/ == arecordCreate()

  • DELETE /REST/ARecord/ == arecordDelete()

Some endpoints accept variable inputs, in which case discrete methods have been provided to reduce ambiguity. For example, the REST/ARecord/ GET endpoint accepts an optional record ID. Without it, the API returns a list of A records assigned to the specified FQDN. With it, the API returns the specific data of the singularly identified A record. Within Dynect-PHP, this functionality has been made into two separate methods: arecordGetList() and arecordGet().

Most methods return either the data requested from the API endpoint, or boolean false on failure of any sort.

The raw response from the Dynect API is available as a public variable $response.

Usage

include_once( 'dynect.php' );
$customer_name = 'somecustomer';
$user_name = 'someuser';
$password = 'somepass';

$dyn = new Dynect();
if ( $dyn->login( $customer_name, $user_name, $password ) ) {
	// get a list of zones:
	$zones = $dyn->zoneGetlist();
	// show the raw API response for the previous action:
	print_r( $dyn->result );
	
	// create a new zone
	if ( $dyn->zoneCreate( '[email protected]', 'example.com', 3600 ) ) {
		echo 'Zone example.com successfully created.';
	}
	$dyn->logout();
}

License

Copyright 2011 Scott Merrill

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

dynect-rest-php's People

Contributors

alanivey avatar skpy avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.