GithubHelp home page GithubHelp logo

ddspringle / cfesi Goto Github PK

View Code? Open in Web Editor NEW
0.0 2.0 0.0 86 KB

An ESI API wrapper for Eve Online written in CFML

License: Apache License 2.0

ColdFusion 100.00%
api-wrapper eve-online esi-api cfml

cfesi's Introduction

CFESI

An ESI API wrapper for Eve Online written in CFML

Current version: 1.0.10

The EVEESIService CFC contains an API interface to the Eve Online ESI API - latest build: 2017-06-10

This code is bundled with the EVESSOService CFC which provides functions to assist with getting OAuth 2.0 tokens from Eve Online for use with the API. Error handling in these CFC's are minimal, at best, and this is best left to the implementation of the API wrapper and not handled directly within the API wrapper itself.

The ESI API and SSO wrappers will both check for a successful call (HTTP 200 OK) and will automatically parse the JSON results and return them. Any other status code will return the entire http result, including headers and other information for debug purposes.

Sample ESI Usage:

	esi = new EVEESIService();
  
	writeDump( esi.getAlliances() );

Full documentation of the CFESI API Wrapper

Sample SSO Usage

Login Page:

	sso = new EVESSOService( clientId = '[CLIENT ID]', secretKey = '[SECRET KEY]', redirectURL = '[URL]' );

	<a href="#sso.getLoginURL()#">Login With Eve Online</a>

Callback:

	if( sso.hasCorrectState( URL.state ) ) {
		tokenStruct = sso.getAccessTokenByAuthCode( URL.code );
	}

	writeDump( tokenStruct );

Compatibility

  • Adobe ColdFusion 9+
  • Lucee 4.5+

Bugs and Feature Requests

If you find any bugs or have a feature you'd like to see implemented in this code, please use the issues area here on GitHub to log them.

Contributing

This project is actively being maintained and monitored by Denard Springle. If you would like to contribute to this code base please feel free to fork, modify and send a pull request!

License

The use and distribution terms for this software are covered by the Apache Software License 2.0 (http://www.apache.org/licenses/LICENSE-2.0).

cfesi's People

Contributors

ddspringle avatar

Watchers

 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.