API Library Guidelines

From EVEDev
Jump to: navigation, search

This is a community effort to define a cross-language set of conventions towards API access library function naming schemes.

Contents

Logic Conventions

API classes should be instantiated and have an API Key and UserID set up on or immediately after instantiation by a call to a function.

Naming Conventions

Generic Data

Skill Tree
all_skills
Arguments: None
Other: No API Key or UserID required
Reference Types
ref_types
Arguments: None
Other: No API Key or UserID required
Alliance List
alliance_list
Arguments: None
Other: No API Key or UserID required
Sovereignty
sovereignty
Arguments: None
Other: No API Key or UserID required

Character Data

Character List
character_list
Arguments: None
Character Sheet
character_sheet
Arguments: characterID
Skill in Training
character_training
Arguments: characterID

Wallet Data

Corporation Data

Corporation Wallet Journal
corp_journal
Arguments: characterID, beforeRefID, accountKey
Corporation Wallet Transactions
corp_transactions
Arguments: characterID, beforeRefID, accountKey
Corporation Wallet Balance
corp_balance
Arguments: characterID, beforeRefID, accountKey

Personal Data

Personal Wallet Journal
character_journal
Arguments: characterID, beforeRefID
Personal Wallet Transactions
character_transactions
Arguments: characterID, beforeRefID
Personal Wallet Balance
character_balance
Arguments: characterID, beforeRefID

Member Tracking

Member Tracking
member_tracking
Arguments: characterID

List of APIs using these conventions

  • None yet, add away

Changes and Contributions

Please discuss changes to this document in the talk page or on IRC. This is a draft.

Personal tools